home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chpgvx.z / chpgvx
Encoding:
Text File  |  2002-10-03  |  9.4 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHPGVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex generalized Hermitian-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHPGVX( ITYPE, JOBZ, RANGE, UPLO, N, AP, BP, VL, VU, IL, IU,
  15.                         ABSTOL, M, W, Z, LDZ, WORK, RWORK, IWORK, IFAIL, INFO
  16.                         )
  17.  
  18.          CHARACTER      JOBZ, RANGE, UPLO
  19.  
  20.          INTEGER        IL, INFO, ITYPE, IU, LDZ, M, N
  21.  
  22.          REAL           ABSTOL, VL, VU
  23.  
  24.          INTEGER        IFAIL( * ), IWORK( * )
  25.  
  26.          REAL           RWORK( * ), W( * )
  27.  
  28.          COMPLEX        AP( * ), BP( * ), WORK( * ), Z( LDZ, * )
  29.  
  30. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  31.      These routines are part of the SCSL Scientific Library and can be loaded
  32.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  33.      directs the linker to use the multi-processor version of the library.
  34.  
  35.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  36.      4 bytes (32 bits). Another version of SCSL is available in which integers
  37.      are 8 bytes (64 bits).  This version allows the user access to larger
  38.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  39.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  40.      only one of the two versions; 4-byte integer and 8-byte integer library
  41.      calls cannot be mixed.
  42.  
  43. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  44.      CHPGVX computes selected eigenvalues and, optionally, eigenvectors of a
  45.      complex generalized Hermitian-definite eigenproblem, of the form
  46.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  47.      assumed to be Hermitian, stored in packed format, and B is also positive
  48.      definite.  Eigenvalues and eigenvectors can be selected by specifying
  49.      either a range of values or a range of indices for the desired
  50.      eigenvalues.
  51.  
  52.  
  53. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  54.      ITYPE   (input) INTEGER
  55.              Specifies the problem type to be solved:
  56.              = 1:  A*x = (lambda)*B*x
  57.              = 2:  A*B*x = (lambda)*x
  58.              = 3:  B*A*x = (lambda)*x
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      JOBZ    (input) CHARACTER*1
  75.              = 'N':  Compute eigenvalues only;
  76.              = 'V':  Compute eigenvalues and eigenvectors.
  77.  
  78.      RANGE   (input) CHARACTER*1
  79.              = 'A': all eigenvalues will be found;
  80.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  81.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  82.  
  83.      UPLO    (input) CHARACTER*1
  84.              = 'U':  Upper triangles of A and B are stored;
  85.              = 'L':  Lower triangles of A and B are stored.
  86.  
  87.      N       (input) INTEGER
  88.              The order of the matrices A and B.  N >= 0.
  89.  
  90.      AP      (input/output) COMPLEX array, dimension (N*(N+1)/2)
  91.              On entry, the upper or lower triangle of the Hermitian matrix A,
  92.              packed columnwise in a linear array.  The j-th column of A is
  93.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  94.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  95.              j)/2) = A(i,j) for j<=i<=n.
  96.  
  97.              On exit, the contents of AP are destroyed.
  98.  
  99.      BP      (input/output) COMPLEX array, dimension (N*(N+1)/2)
  100.              On entry, the upper or lower triangle of the Hermitian matrix B,
  101.              packed columnwise in a linear array.  The j-th column of B is
  102.              stored in the array BP as follows:  if UPLO = 'U', BP(i + (j-
  103.              1)*j/2) = B(i,j) for 1<=i<=j; if UPLO = 'L', BP(i + (j-1)*(2*n-
  104.              j)/2) = B(i,j) for j<=i<=n.
  105.  
  106.              On exit, the triangular factor U or L from the Cholesky
  107.              factorization B = U**H*U or B = L*L**H, in the same storage
  108.              format as B.
  109.  
  110.      VL      (input) REAL
  111.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  112.              the interval to be searched for eigenvalues. VL < VU.  Not
  113.              referenced if RANGE = 'A' or 'I'.
  114.  
  115.      IL      (input) INTEGER
  116.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  117.              order) of the smallest and largest eigenvalues to be returned.  1
  118.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  119.              referenced if RANGE = 'A' or 'V'.
  120.  
  121.      ABSTOL  (input) REAL
  122.              The absolute error tolerance for the eigenvalues.  An approximate
  123.              eigenvalue is accepted as converged when it is determined to lie
  124.              in an interval [a,b] of width less than or equal to
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              ABSTOL + EPS *   max( |a|,|b| ) ,
  141.  
  142.              where EPS is the machine precision.  If ABSTOL is less than or
  143.              equal to zero, then  EPS*|T|  will be used in its place, where
  144.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  145.              AP to tridiagonal form.
  146.  
  147.              Eigenvalues will be computed most accurately when ABSTOL is set
  148.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  149.              this routine returns with INFO>0, indicating that some
  150.              eigenvectors did not converge, try setting ABSTOL to
  151.              2*SLAMCH('S').
  152.  
  153.      M       (output) INTEGER
  154.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  155.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  156.  
  157.      W       (output) REAL array, dimension (N)
  158.              On normal exit, the first M elements contain the selected
  159.              eigenvalues in ascending order.
  160.  
  161.      Z       (output) COMPLEX array, dimension (LDZ, N)
  162.              If JOBZ = 'N', then Z is not referenced.  If JOBZ = 'V', then if
  163.              INFO = 0, the first M columns of Z contain the orthonormal
  164.              eigenvectors of the matrix A corresponding to the selected
  165.              eigenvalues, with the i-th column of Z holding the eigenvector
  166.              associated with W(i).  The eigenvectors are normalized as
  167.              follows:  if ITYPE = 1 or 2, Z**H*B*Z = I; if ITYPE = 3,
  168.              Z**H*inv(B)*Z = I.
  169.  
  170.              If an eigenvector fails to converge, then that column of Z
  171.              contains the latest approximation to the eigenvector, and the
  172.              index of the eigenvector is returned in IFAIL.  Note: the user
  173.              must ensure that at least max(1,M) columns are supplied in the
  174.              array Z; if RANGE = 'V', the exact value of M is not known in
  175.              advance and an upper bound must be used.
  176.  
  177.      LDZ     (input) INTEGER
  178.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  179.              'V', LDZ >= max(1,N).
  180.  
  181.      WORK    (workspace) COMPLEX array, dimension (2*N)
  182.  
  183.      RWORK   (workspace) REAL array, dimension (7*N)
  184.  
  185.      IWORK   (workspace) INTEGER array, dimension (5*N)
  186.  
  187.      IFAIL   (output) INTEGER array, dimension (N)
  188.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  189.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  190.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  191.              is not referenced.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHPPPPGGGGVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      INFO    (output) INTEGER
  207.              = 0:  successful exit
  208.              < 0:  if INFO = -i, the i-th argument had an illegal value
  209.              > 0:  CPPTRF or CHPEVX returned an error code:
  210.              <= N:  if INFO = i, CHPEVX failed to converge; i eigenvectors
  211.              failed to converge.  Their indices are stored in array IFAIL.  >
  212.              N:   if INFO = N + i, for 1 <= i <= n, then the leading minor of
  213.              order i of B is not positive definite.  The factorization of B
  214.              could not be completed and no eigenvalues or eigenvectors were
  215.              computed.
  216.  
  217. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  218.      Based on contributions by
  219.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  220.  
  221.  
  222. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  223.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  224.  
  225.      This man page is available only online.
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.